home *** CD-ROM | disk | FTP | other *** search
/ Ultimedia 1 / Ultimedia 1.iso / tools / soundtools / dsound / dsound.doc < prev    next >
Encoding:
Text File  |  1994-07-21  |  6.6 KB  |  142 lines
  1.  
  2.                 DSound V1.50
  3.  
  4.      DSound is Copyright 1991-1994 by Dave Schreiber, All Rights Reserved.
  5. This program is freely distributable, but may not be sold (although a small
  6. fee for copying, media, etc. may be charged).
  7.  
  8.      The files minrexx.o and minrexx.h, included with this distribution,
  9. are exempt from this copyright, as I did not create them.
  10.  
  11.      DSound is utility I wrote to play 8SVX sound samples directly off a
  12. hard drive.  While it only takes up a small amount of chip RAM, it can play
  13. samples of unlimited size off a hard drive (it doesn't work to well with
  14. floppies however). Currently, it cannot play compressed sound files.
  15.  
  16. USING DSOUND
  17. ------------
  18.      DSound can be used from any form of mass storage (such as hard drives,
  19. flopticals, Syquest drives, etc) except floppy disks. To use DSound, type
  20. "DSound [flags] <filename>" (without the quotes), where <filename> is the
  21. name of the file that you want to play, and [flags] are any of the flags
  22. listed below under "Usage." To stop DSound before a sample is finished
  23. playing, either click on the close gadget in the DSound window (which is
  24. displayed while DSound is playing a sound sample, unless the '-w' flag is
  25. used), press CTRL-C in the Shell window from which DSound was started, type
  26. "break <clinum>", where <clinum> is the number of the Shell window that
  27. DSound is running in, or use DSound's ARexx port (see below).
  28.  
  29. Usage:
  30.    dsound [-l][-r][-2][-f][-m][-o][-w][-n][-t]
  31.                   [-s<speed>][-v<volume>][-b<bufsize>] file
  32.  
  33. Where the flags are defined as such:
  34.   -l -- Play the sample using the left speaker
  35.   -r -- Play the sample using the right speaker
  36.   -2 -- Play the sample using both speakers
  37.   -f -- Shut off the low-pass filter
  38.   -m -- Load the entire sample into memory
  39.   -o -- Play the sample continuously (loop)
  40.   -w -- Do not open the DSound window
  41.   -n -- Do not show the sample name in the window
  42.   -t -- Do not show the sample times in the window
  43.   -s<speed> -- Play the sample at the given speed (samples/sec)
  44.   -v<volume> -- Play the sample at the given volume (0-64)
  45.   -b<bufsize> -- Use a buffer of size <bufsize> (default is 30K)
  46.  
  47. If you don't specify any flags, the defaults are to play the sound out of
  48. the first available speaker, with the filter on, at the speed and volume
  49. specified in the soundfile.
  50.  
  51.      New with version 1.40 of DSound is the ability to halt DSound via an
  52. ARexx command.    Specifically, sending a copy of DSound the command "quit"
  53. will cause it to immediate stop playing the sample and exit. DSound's port
  54. is called "DSound.x", where 'x' ranges from 1 to 99;  each instance of
  55. DSound will have a different value for 'x'.  An ARexx script which
  56. demonstrates this, called "QuitDSound.rx", is included in this
  57. distribution.
  58.  
  59. WORKBENCH SUPPORT
  60. -----------------
  61.      Another feature found first in version 1.40 is Workbench support. If
  62. you make DSound the "default tool" of some sound sample, double clicking on
  63. that sample's icon will cause DSound to play the sample.  You can also play
  64. a sample by clicking once on DSound's icon, then (while holding the shift
  65. key down) double-clicking on the sound sample's icon.  In either case, when
  66. using DSound from Workbench, you cannot specify the various options given
  67. under "Usage;"  you need to run DSound from the CLI in order to adjust how
  68. DSound plays samples. Quitting from DSound, when run from Workbench, is
  69. accomplished either by clicking on DSound's close gadget or using an ARexx
  70. script.
  71.  
  72.      With version 1.50, DSound now supports Workbench tool types.  These
  73. are program options entered in the "Tool Types" box, which is part of the
  74. Workbench "Information" window for an icon.  One can bring up this window
  75. by clicking on an icon and selecting the "Information..." item from the
  76. "Icons" menus in Workbench.  Each tool type is in the form
  77. "<attribute>=<value>", where <attribute> is a particular program attribute
  78. (such as playback volume) and <value> is the value it is to take;  both
  79. <attribute> and <value> have to be in all capital letters. DSound will use
  80. tool type information from both its own icon and the icon of the sound
  81. sample to be played;  if there is a conflict between tool type information
  82. in the two icons, the information in the sound sample's icon takes
  83. precedence.
  84.  
  85. A list of tool type attributes follows, along with equivalent command-line
  86. flags and default values used when given attributes are not specified:
  87.  
  88. SPEAKER -- Determines which speaker the sample plays out of.  The <value>
  89. for this attribute can be "LEFT" (left speaker, "-l"), "RIGHT" (right
  90. speaker "-r"), "BOTH" (both speakers, "-2"), or "DONTCARE" (when you don't
  91. care what speaker is used).  The default value is "DONTCARE".
  92.  
  93. SPEED -- The playback speed (equivalent to the "-s" flag).  The <value> is
  94. a number less than 28000 which is the speed (in samples/second) at which
  95. the sample should be played.  The default speed is specified by
  96. each individual sound sample.
  97.  
  98. VOLUME -- The playback volume (equivalent to the "-v" flag).  <value>
  99. ranges from 0 (silent) to 64 (loudest).  The default volume is 64
  100. when not specified by a sound sample.
  101.  
  102. BUFSIZE -- The amount of memory dedicated to playing samples, in bytes.
  103. Default is 30000.
  104.  
  105. (The remaining attributes take either "YES" or "NO" as <value>)
  106.  
  107. PLAYWINDOW -- Determines if the DSound window is opened.  Default is "YES".
  108. Equivalent to the "-w" flag.
  109.  
  110. TITLETIME -- If the DSound window is opened, determines if it should
  111. contain sample times.  Default is "YES".  Equivalent to the "-t" flag.
  112.  
  113. TITLENAME -- If the DSound window is opened, determines if it should
  114. contain the name of the sample.  Default is "YES". Equivalent to the "-n"
  115. flag.
  116.  
  117. READALL --  Determines if the entire sample should be loaded into memory at
  118. once, rather than being played off of disk.  Defaults to "NO".  Equivalent
  119. to the "-m" flag.
  120.  
  121. FILTER -- Determines if the low-pass filter should enabled during playback.
  122. Defaults to "YES". Equivalent to the "-f" flag.
  123.  
  124. LOOP -- Determines if the sample should be played continuously (in a loop).
  125. Defaults to "NO".  Equivalent to the "-o" flag.  WARNING:  specifying
  126. "LOOP=YES" and "PLAYWINDOW=NO" will cause DSound to play a sample
  127. continuously without any obvious way of stopping it.  Because of this, a
  128. requester will pop up and request confirmation when these two tool types
  129. have been specified so as to ensure that that's really what you want.  In
  130. any case, you can use ARexx to stop DSound in this instance.
  131.  
  132. COMPILING DSOUND
  133. ---------------
  134. I've included the source for DSound.  To compile (using SAS/C V6) type:
  135.    smake
  136.  
  137. GETTING IN TOUCH WITH THE THE AUTHOR
  138. ------------------------------------
  139. If you have any questions, comments, etc. regarding DSound, you can get in
  140. touch with me via Internet e-mail at davids@cse.ucsc.edu .
  141.  
  142.